package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SalaryBillSendAddDTO;
import org.jsola.hr.dto.SalaryBillSendUpdateDTO;
import org.jsola.hr.query.SalaryBillSendQuery;
import org.jsola.hr.query.SalaryBillSendRelQuery;
import org.jsola.hr.vo.SalaryBillListVO;
import org.jsola.hr.vo.SalaryBillSendListVO;
import org.jsola.hr.vo.SalaryBillSendVO;

import javax.validation.Valid;
import java.util.List;

/**
 * 工资条发放信息
 *
 * @author zhr
 */
@Api(tags = "hr-工资条发放信息")
public interface ISalaryBillSendControllerAPI {

    /**
     * 新增工资条发放信息
     * @param salaryBillSendAddDTO 工资条发放信息新增实体
     * @return 工资条发放信息展示对象
     */
    @ApiOperation(value = "新增工资条发放信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendAddDTO", dataType = "SalaryBillSendAddDTO", value = "新增工资条发放信息", paramType = "body")
    })
    Result<SalaryBillSendVO> save(SalaryBillSendAddDTO salaryBillSendAddDTO);


    /**
     * 修改工资条发放信息
     * @param salaryBillSendUpdateDTO 工资条发放信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改工资条发放信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendUpdateDTO", dataType = "SalaryBillSendUpdateDTO", value = "修改工资条发放信息", paramType = "body")
    })
    Result<Integer> update(SalaryBillSendUpdateDTO salaryBillSendUpdateDTO);




    /**
     * 删除单个工资条发放信息，彻底删除
     * @param salaryBillSendId 工资条发放信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个工资条发放信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendId", dataType = "String", value = "工资条发放信息id", paramType = "path")
    })
    Result<Integer> delete(String salaryBillSendId);


    /**
     * 批量删除工资条发放信息，彻底删除
     * @param salaryBillSendIds 工资条发放信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除工资条发放信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendIds", dataType = "String[]", value = "工资条发放信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] salaryBillSendIds);


    /**
     * 根据工资条发放信息id查询工资条发放信息详情
     * @param salaryBillSendId 工资条发放信息id
     * @return 工资条发放信息详情
     */
    @ApiOperation(value="根据工资条发放信息id查询工资条发放信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendId", dataType = "String", value = "工资条发放信息id", paramType = "path")
    })
    Result<SalaryBillSendVO> findById(String salaryBillSendId);


    /**
     * 查询工资条发放信息
     * @param salaryBillSendQuery 工资条发放信息查询参数
     * @return page
     */
    @ApiOperation(value="查询工资条发放信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendQuery", dataType = "SalaryBillSendQuery", value = "工资条发放信息查询参数", paramType = "query")
    })
    Result<List<SalaryBillSendListVO>> listAll(SalaryBillSendQuery salaryBillSendQuery);


     /**
     * 分页查询工资条发放信息
     * @param salaryBillSendQuery 工资条发放信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询工资条发放信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendQuery", dataType = "SalaryBillSendQuery", value = "工资条发放信息查询参数", paramType = "query")
    })
    Result<Page<SalaryBillSendListVO>> page(SalaryBillSendQuery salaryBillSendQuery);


    /**
     * 查询工资条发放详情tab
     * @param salaryBillSendQuery 工资条发放信息查询参数
     * @return 工资条发放信息VO
     */
    @ApiOperation(value="查询工资条发放详情tab")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendQuery", dataType = "SalaryBillSendQuery", value = "工资条发放信息查询参数", paramType = "query")
    })
    Result<SalaryBillSendVO> salaryBillSendDetailTab(SalaryBillSendQuery salaryBillSendQuery);


    /**
     * 分页查询工资条发放记录
     * @param salaryBillSendQuery 工资条发放信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询工资条发放记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendQuery", dataType = "SalaryBillSendQuery", value = "工资条发放信息查询参数", paramType = "query")
    })
    Result<Page<SalaryBillSendListVO>> salaryBillSendListPage(SalaryBillSendQuery salaryBillSendQuery);


    /**
     * 根据发放信息查询工资条分页
     * @param salaryBillSendRelQuery 工资条发放信息关联查询参数
     * @return page
     */
    @ApiOperation(value="根据发放信息查询工资条分页")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendRelQuery", dataType = "SalaryBillSendRelQuery", value = "工资条发放信息关联查询参数", paramType = "query")
    })
    Result<Page<SalaryBillListVO>> salaryBillListPageBySend(@Valid SalaryBillSendRelQuery salaryBillSendRelQuery);


    /**
     * 根据发放信息查询工资条分页
     * @param salaryBillSendRelQuery 工资条发放信息关联查询参数
     * @return page
     */
    @ApiOperation(value="根据发放信息查询工资条分页")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendRelQuery", dataType = "SalaryBillSendRelQuery", value = "工资条发放信息关联查询参数", paramType = "query")
    })
    Result<Page<SalaryBillListVO>> salaryBillPageBySendDetail(@Valid SalaryBillSendRelQuery salaryBillSendRelQuery);


    /**
     * 工资表撤回工资条
     * @param salaryBillSendUpdateDTO 修改工资条发放信息对象
     * @return Integer
     */
    @ApiOperation(value="工资表撤回工资条")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryBillSendUpdateDTO", dataType = "SalaryBillSendUpdateDTO", value = "修改工资条发放信息对象", paramType = "body")
    })
    Result<Integer> withdraw(@Valid SalaryBillSendUpdateDTO salaryBillSendUpdateDTO);


}

